Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update Guardian Key/Signer Documentation #4273

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pleasew8t
Copy link
Contributor

No description provided.

Copy link
Contributor

@johnsaigle johnsaigle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be worth fixing up these references since the whitepaper was renamed

sdk/vaa/structs.go
765:            // https://github.com/wormhole-foundation/wormhole/blob/main/whitepapers/0009_guardian_key.md

node/pkg/p2p/p2p.go
1017:   // SECURITY: see whitepapers/0009_guardian_key.md
1075:   // SECURITY: see whitepapers/0009_guardian_key.md

whitepapers/0010_integrity_checkers.md
42:* `Pre-Observation` - used to designate an observation being submitted to the integrity checker contract by a Wormhole Guardian. They are similar to observations, i.e. a Wormhole message signed by a single guardian, but can be distinguished by their prefix and signature format. They follow the same signature format as signed gossip messages described in [guardian key usage](0009_guardian_key.md) with a unique signature prefix.  Signed pre-observations therefore cannot be used like signed observations to create a VAA.

whitepapers/0013_ccq.md
106:In order to differentiate signatures and prevent replay attacks of requests intended for devnet/testnet from mainnet ones, the following prefixes MUST be used when signing. These prefix strings are padded to 35-bytes to align with [Guardian Key Usage](0009_guardian_key.md) and existing code.

@johnsaigle johnsaigle added documentation Improvements or additions to documentation node labels Feb 21, 2025
@djb15 djb15 self-requested a review February 22, 2025 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation node
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants